Waldo is dedicated to my mother who loved books and people.
Thanks to Constance Westrope for her unending encouragement.
June 1994
To run Waldo you must change the application size of HyperCard to 2000. Consult your Macintosh manuals for specific information on changing the size of programs or read the Read Me First file that came with Waldo.
§NOTE:§When using System 7 be sure to convert your new copy of Waldo to a ~Stationary Pad~ so that when you will always have a fresh copy of Waldo when you need it. Consult your Macintosh documentation about Startionary Pads.
~See the version history document for a complete history of bug fixes.~
Release of Waldo version 4
§IMPORTANT NOTE§: Do not include quotes in a Title. This will confuse Waldo and text will not format correctly!
~Please support ShareWare! This is the only way that programmers can provide good and inexpensive software to the public.~
§NOTE:§ Waldo requires that you use HyperCard version 2.0 or higher. Version 4.0.3+ of Waldo works with version 2.2 of HyperCard.
A hard disk is required for Waldo.
§NOTE:§ HyperCard Help is available from all Pages in Waldo! If the HyperCard stack called WALDOHELP is at the same level as the current copy of Waldo, then "holding down" Shift and Command keys while holding down the key with "?" will display an interactive HyperCard help stack for Waldo.
(You may also access WALDOHelp by holding down the Shift key and selecting Help from the "Go" menu.)
If no document is loaded into Waldo and the Command key is held down and the "?" key is pushed, the standard HyperCard Help stack is displayed if available. If there is a document loaded, then the Command and "?" keys will bring up a HyperCard stack named (name of the document loaded)+Help, e.g.,NEWSHELP not NEWS HELP.(That is, if one was provided by the author and it is present at the same level as the document in a Shareware Waldo and next to a Waldo OpenBook .)
(Authors may include help stacks with any Waldo document.)
Waldo is $10. Other ShareWare Waldo programs are available.If you use Waldo for more than a month, then please make your check out to:
John J. Gaudreault
Send to:
ARTWAY
P.O. Box 3442
Omaha, NE 68103
^
*New to Version 4*
• New interface design (new icons and icon placement)
• New button panel interface for Title List
• Scan Title List Button: This button is eliminated but the function is integrated into Title List button panel
• ReNumber Button: This button has been eliminated--new function is ReTitle and has been integrated into the Title List button panel
• New button panel interface for HyperQueues and now move forward and backward
• New button panel interface for HyperQueue List
• All Utility buttons are placed in appropriate dialog/button panel
• TwinText: Now use Shift key (previously Option key) to reset to previous set
• Find Button: Use the Shift key to reset Find button (previously Command key)
• XRes now added to Queue from interactive list generated from XRes stack or by typing in name
• HyperQueue Button: New button to "enter" HyperQueue in addition to menu, keyboard and clicking on word
• HyperQueue only: In button panel use the first letter of the name of each button in the button panel to perform operations
• GroupPages: Formerly called Folded Pages--same function different name
• XStack Button: Now is a List function and XStack Buttons added from within Waldo
• HyperQueue lists, XStack Lists and Title lists may be appended to the end of documents, using cut and paste, and subsequently loaded as the document is loaded.
The first time an XStack List is added it may be automatically appended to the document. Subsequently modified XStack lists are manually pasted into the document.
• New form for HyperQueue lists which means older lists must be converted into version 4 form to be used with Waldo 4.
^
*|What is a Waldo|*
^
*Making Waldos--personal and powerful*
Take a word processing file and place a few characters. Save the file to disk as plain text. (Some word processors say plain text, ASCII text, or just “text” in the save dialog.) Start Waldo and load the document into Waldo. When the document is loaded into Waldo a Table of Contents is created for the document. Use the Table of Contents to navigate the document. Tables of Contents and Pages are the simplest level of organization Waldo adds to documents.
Readers and authors may save Titles of Pages into a list called the Title list. Titles may be added in any order. Use the Title list to further organize a document. Notes may be added to a Title list. Items in a Title list may be indented to further structure a list. The Find function may be used to automatically add Titles to a Title list.
Individual words may be added to a list, called a HyperQueue, by holding down the Shift key and clicking on a word. This list is another way to structure a document. Notes may be added to each Spot. Graphics and other resources may be added to Spots. (A Spot is a word added to a Queue.)
You can use the Page Button to Mark Pages. Marked Pages may be accessed separately. The Title List may be used to Mark Pages.
You have taken a simple document and turned it into a highly structured document. It has tables, indexes, notes and graphics. It is much more readable than before. The document has been personalized. You may send these additions (lists & resources & tables) to another person reading the same document. Reading becomes not only easier but more personal and powerful.
You may write your own documents to be turned into Waldos or take someone else’s and convert it into a Waldo. Manuals, books, magazines, scholarly papers, business documents and school papers may be converted into Waldos. Even documents of medium length will benefit when read in Waldo. The longer the document the more dramatic the added benefits. But even with shorter documents you may add notes and MultiMedia.
^
*The Real World - A*
Paul Perfect, a college biology professor, wants to publish a new textbook on amphibians. Paul isn’t able to find a publisher and decides to publish it himself. After making the decision to self-publish Paul decides to use Waldo and add many multimedia features that could not be put in a traditional book. Paul wants to protect his work but at the same time wants students to be able to interact with his digital book. Paul registers Waldo with ARTWAY for the OpenBook™ features in addition to the basic registration fee. (Paul receives a password to unlock these features.) Now Paul can “lock” his text and graphics into his Waldo book on amphibians--this locked book is called a Waldo §OpenBook§.
Paul’s students are able to read the amphibian textbook and add notes and their own illustrations to Paul's book without altering the book itself. Professors in another state start using Paul's textbook in their classes send Paul HyperQueue notes and graphics they added to Paul’s book. Paul “loads” them into his copy and views them in his book.
Paul’s book becomes a great success with both students and professors and fills a niche that would not be financially lucrative for a large publisher. But because the book is self published it brings Paul both financial and personal rewards.
^
*The Real World - B*
Let’s try it again with a “real” document.
Construction Inc. hires FindIt!, a research firm, to do a report on a proposed construction project for a government agency. The report includes an environmental impact study. The final report is a lengthy and complex document printed and bound in a book format. It is too difficult to be understood clearly. Construction Inc. asks for a plain text file of the document and the graphics files to be put on disks. A worker at Construction Inc. takes the document and quickly codes it and loads it into Waldo. The graphic files are pasted into the Waldo utility§XHome§and a XRes stack is created. The worker rapidly goes through the document attaching the graphics to places in the text. Certain Pages in the document have been marked for XStacks and the worker creates XStacks to be read from those Pages. The XStacks contain extra information Construction Inc. has added. Finally those responsible for the project use the HyperQueue Note function to embed notes in the text. The~new~document is easy to read and understand and is used to make a decision to proceed with a bid that wins them a lucrative government contract.
^
*The Real World - C*
Spencer is creating a new “magazine” for people interested in new technologies called TechMan. He solicits articles from others on InterNet and other commercial BBS’s he belongs to. Spencer makes sure that his contributors know the simple formatting characters for Waldo documents. Each author E-Mails Spencer his Waldo formatted article and a collection of graphics files. Spencer, using standard Mac copy and paste techniques, assembles the articles into one large document. The graphics are pasted into XHome and an XRes stack is created. The document is loaded into a copy of Waldo. Spencer, reading the finished document in Waldo, adds illustrations and an animation. Sounds had been record from with XHome and these are now placed in the document as well. All of the notes, sound and graphics links added to the HyperQueue are saved to disk. Spencer, again using copy and paste techniques, copies the HyperQueue list saved to disk and using his word processor pastes the HyperQueue list at the end of the document and saves it to disk
Spencer uploads his magazine TechMan to various BBS’s. Readers download the text file. The reader loads the document into their own copy of Waldo.The reader decides that he wants to see the magazine illustrations and so downloads the XRes stack. (Since Spencer has added the HyperQueue list to the end of the document it was automatically loaded when the reader loaded the document into his copy of Waldo.) All graphics and sounds are now immediately accessible from within the magazine. TechMan becomes very popular and Spencer's readers number in the thousands. Spencer starts making money when he is able to solicit advertisements based on TechMan’s popularity.
^
*The Meaning of Waldo.*
§NOTE:§ Waldo requires that you use HyperCard version 2.0 or higher. A hard disk is required for Waldo.
Take a text file from any word processor and “mark it up” then load it into Waldo. Add notes and graphics and interactive HyperCard stacks.
Waldo is the most powerful and easiest to use of all hypertext programs. Waldo's low price, powerful features, ease of use, IBM compatibility and online help combine to give the best value available.
Waldo’s strength is to add so much power, so easily, to simple text. Waldo gives the author and the§reader§the ability to easily link text (HyperQueue ) and access the links from a list (HyperQueue List) . These links may have notes attached to them as well as graphics, sounds and more. Tables of contents and sub-tables of contents organize the text for instant recall.
Waldo is an application for reading and referencing large amounts (up to 999 “Pages”) of information. That information may be in magazine or book format or database files. With Waldo, you can begin publishing your own DM (Digital Magazine) or DB (Digital Book).
Waldo is a powerful means of distributing DMs and DBs over modems, networks and on disk. Now simply use your favorite word processor to create your book, newspaper, magazine, corporate newsletter, client newsletter, medical newsletter, etc. Waldo is versatile enough to publish technical notes and scholarly monographs. Waldo is perfect for creating user's manuals of all types.
^
*Waldo extends the written word*
Waldo uses text written in other applications. The files to be read are created with an outliner, word processor, database or other text-file-creating application. Think of Waldo like as a “page layout” application. Waldo has features that make it specially suited for reading information--as a vehicle for the distribution information. Waldo also has a variety of tools to give the reader the power to customize the document by reorganizing the information into new relationships by linking Pages and words. The reader may paste text and graphics into floating and resizable windows. So while Waldo documents are created in other programs in Waldo you may add many types of resources to the document in the form of links, notes and graphics.
Waldo does have the ability to Copy Text from a document Page into the Macintosh’s clipboard. Text can be pasted into another Macintosh application. Waldo can add notes and graphics to Waldo documents.
§OpenBook:§ OpenBook authors have the option of locking out the copy text and printing features of a Waldo.
^
*Navigation, Pages and Titles*
Waldo has several features that set it apart from other applications. Waldo has special navigation and referencing features such as Find Lists, Title Lists, HyperQueue Lists, the Page Button, Tables of Contents, GroupPages (sub-Tables of Contents), XStacks Buttons, XStack Lists, XRes, and others.
Refer to Buttons (Front Page / All Other Pages) for more complete information on buttons.
You may save Page & Title references into Title Lists. You may save often-searched-for words and phrases into Find Lists. The Title List, Find List and HyperQueue List may be saved to and loaded from disk--these same lists may be pasted into the document. Waldo's ability to have Titles, Tables of Contents, GroupPage Tables and GroupPages gives the power to organize large amounts of information into logical blocks of Pages with Tables to access them from. Waldo also gives the reader tools to reorganize the information to meet his individual needs.
^
*Waldo does Pictures.*
XStack is short for external stack. Waldo will recognize XStack characters--the Yen symbol, ¥ plus a number from 0 to 999. (The Yen symbol in most fonts is Option Y with Caps Lock "up" or disabled.) an XStack can be a single card HyperCard stack with special stack script that will take the reader back to the Page from which he left. A click of the mouse would display an XStack and another click takes you back to the Page. XStack could easily contain animation and sound. The limitation is your imagination and the size of the stack. (Pictures can contain color if they contain color Pict resources. Beginning with version 2.1 (04/92) of HyperCard QuickTime movies and Apple Events are supported. See your HyperCard handbook about displaying color Pict resources.)
Click on the "XStack List" icon and you will be shown a List of all XStack Buttons and their Page, if there are any in the current document. If there are not any XStack Buttons in the current document, then the "XStack List" will be empty. The XStack stack must be named the same as the document with the ¥ at the end of the name, and a number from 0 to 999, IMFOMAT¥1 and should reside at the same level as the document. (In an OpenBook the XStacks are at the same level as the OpenBook.) The number at the end of an XStack name may not be larger than the number of pages in the Waldo.
You may "program" a note for a Spot in a HyperQueue to display a picture or play a sound, called an extra resource (XRes™). This is done by clicking on XRes at the bottom of the HyperQueue~note screen~. The note will be able to display a picture or play a sound resource in a special XRes Stack. More about this feature in the description of HyperQueues.
^
*WaldoWare™ and Waldo utilities.*
There are also utilities and applications for Waldo. There is an ARTWAY application that turns Waldo into an editor for writing in Waldo and creating GroupPages and outputs files in Waldo format.
There are WaldoTools for processing pre-written unformatted text into Waldo. Another Waldo Tool will load Styled text (boldface, italics, underline, etc) into Waldo.
XHome™ is a tool for creating XRes stacks and XRes graphics. Some of these programs are available only from ARTWAY. XHome and XTools Jr. are available on online services such as America OnLine and XHome is now included with Waldo.
^
*Waldo Advantage*
Since a Waldo document is a plain text file it is much smaller than the corresponding Waldo with the text loaded. XStacks get to be large files very quickly--a single small XStack can easily be 15k. A small text file transfers over modem quickly and easily and is readable with any word processor. The XStack and XRes are optional and may or may not be transferred depending on the person receiving the files. Small size, optional XStacks & XRes, compatibility with any word processor and the powerful features that Waldo adds, plus the utilities, combine to make a powerful integrated system for the distribution of information.
^
|
*|How to create a Waldo document.|*
^
*A Waldo document is a plain text document*
How to create a Waldo document.
The basics:
A Waldo document uses 3 (ASCII) characters to turn a simple document into a Waldo. The caret, the asterisk, the vertical bar are the only codes needed. (There are 2 more for italic and large text.) By placing these 3 characters into a text file, you can create Pages, Tables of Contents, GroupPages. These 3 concepts give greater order and depth to complex documents. The document itself still remains readable by any word processor, including any IBM PC, but now it can be transmitted to another person possessing Waldo and be read more easily, comfortably and and with greater retention. The Waldo document will be kept and referenced because reading is so much easier with Waldo.
^
*Giving Titles to Pages*
Place a line of text, not to exceed 70 characters, at the beginning of a Page. Place an asterisk at the beginning and the end of the line. Make sure there are no spaces between the leading (first) asterisk and the first character of the Title or between the trailing (last) asterisk and the last character of the Title. Put a RETURN at the end of the line! Actually, any contiguous text no longer than 70 characters may be marked as a Title in this manner; the text does not need to be the first line in a Page, although that is best in most cases. The Title cannot be located beyond the 15th line of a Page!
§NOTE:§Authors do not include quotes in Titles!
§NOTE:§ Authors, HyperCard considers a line any text ending in a return--you may call it a paragraph but HyperCard calls it a line.
Clicking on a Title, in a Table of Contents, takes you to its Page.
Again, the Title must be on a §SINGLE LINE§ with a return--this is important as Waldo uses this format to create Tables of Contents!!
^
*Making Pages*
A caret symbol marks the end of a Page. Place it on a line by itself, followed by a return, at the end of a block of text. §The text for a Page MUST NOT exceed 16k in size.§
The Page is the most basic unit in a Waldo.
^
*Putting a group of Pages together as GroupPages*
The beginning of a series of Grouped Pages is marked by a Group Title. A Group Title begins with an asterisk and a vertical bar. Place a line of text not to exceed 70 characters before the first GroupPage. Place an asterisk and a vertical bar at the beginning and the end of the line. Make sure there are no spaces between the leading (first) asterisk-bar and the first character of the Title nor between the trailing (last) asterisk-bar and the last character of the Title.
Put a caret on the next line by itself followed by a
RETURN.
asterisk-bar. This is the Title bar-asterisk-RETURN
CARET RETURN
Put a Vertical Bar on a line by itself followed by a RETURN, AFTER the caret at the END of the Last Page of the Group.
CARET RETURN
VERTICAL BAR RETURN
"Vertical Bar" is ASCII #124
"Vertical Bar" is the shifted character of the backslash key.
§Note:§ All formatting characters may be seen when this document is read with any word processor.
^
*The GroupPages Table of Contents*
Waldo will create a Group Table for each series of GroupPages. It is functionally equivalent to the Table of Contents on the Front Page. It has the added features of the < Group and the Group > Buttons and clicking on a Title takes you to its Page.
^
*Changing Text Style and Size*
By embedding two ASCII characters, tilde and section, you are able to mark text for italic (tilde) text and 18 point text (section). By placing the character~before~and~after~the text you mark it for Waldo. When loaded into Waldo the text marked is changed into the text style chosen. When placing the format characters do not leave space between words--place the format characters in the space between words. Do not try to span text that goes beyond the end of a line--text that includes a ~RETURN~. The tilde is at the upper left key and is the~shifted~ character. The section character is option key + 6.
Tilde is ASCII 126.
Section is ASCII 164
§Note:§ The use of italic and large text on a Page in a document slows down the loading of that Document Page into Waldo because HyperCard has to modify the actual text “field.”
§Note:§ All formatting characters are shown in the help window on the Front Page.
^
*The XStack Button.*
You can create a “X” button on any Page which will take you to an eXternal HyperCard Stack or XStack. You must, though, create the external stack first before you can go to it. You save the list of XStack buttons you created at the end of the document so that they are automatically loaded the next time you load the document into Waldo. Each item in a list of XStack buttons will contain:
X on Y
X = the number of the XStack and Y the Page it’s button appears on. Any time you add a new XStack button the word “on” will be in lowercase. When a list has been loaded “with” the document then the “ON” will be capitalized.
§OpenBook:§ OpenBook XStack items in the list, loaded with the document, may not be erased. Any new items added after loading may be deleted.
The XStacks are marked in the document through the XStack dialog. Click on the XStack Button and a dialog/list is displayed. Select Edit and then select Add. Select from a list or type a number from 1 to the number of Pages in the document. An XStack button will be created on that Page. This does not create an actual XStack--that must be manually created by the reader or author. The XStack button is a marker telling Waldo that when it is clicked on Waldo is to go to a particular stack. The stack will be named:
The name of the document¥000
Name the XStack the name of the document plus a Yen symbol (¥) and a number (one number from 0 to 999)--use this convention to name any XStacks you create. This marks the stack as an XStack for that particular Waldo document. You may have as many XStacks buttons in a document as there are Pages.
When you have created all of the XStack buttons for your document you save it to the end of that document by clicking Edit and then Save. Whenever you reload the document Waldo will create an XStack button on each Page you placed an XStack button. If a document already has an XStack list in it and you select Save then Waldo will create a file on disk next to your document called “XS.” You will need to open both “XS” and your document in a word processor and copy and paste the new XStack list “over” the old list in your document.
§NOTE:§ When Waldo appends the XStack list to you document it will first add a new line with @ & XStack on a line by itself. Then a list of the Page numbers/ XStack numbers follows. At the end of the list is caret symbol on a line by itself.
Clicking Edit first, then on Add button, will create a button on the XStack icon at the bottom right. It is a small "X." When you click the button, it looks for a HyperCard stack with the name of the file you loaded plus "¥"with a number from 0 to 999--INFOMAT¥0 (it is simple in practice).That stack MUST be at the same "LEVEL" as the FILE you loaded!
§OpenBook:§When reading an OpenBook the XStacks must be at the same level as the OpenBook you’re reading or optionally on an external disk such as a CD ROM.
I recommend you put all files associated with a document in a folder named the same as the document with a "-F" extension for Folder.
"name-F"
Clicking on the X button will display that XStack--a second click (if this is how you programmed it) will return you to the Page you left.
"¥" is ASCII #180 (Option ¥ "caps lock" up--most fonts)The "STACK" SCRIPT of the XStack stack COULD read:
on openStack
hide menuBar
end openStack
on idle
wait until the mouseClick
visual effect iris close
pop card
end idle
----------------
§NOTE:§ This is an example of a "minimum" script and as such represents the least you could do. Use your imagination to create "XStacks" that contain animation, sound and multiple cards, just have some way of "popping the card"to return to the card you left from in Waldo.
^
*More About XStacks--Programming*
XStacks can contain color if they have color Pict resources. See your HyperCard handbook about displaying color Pict resources.The stack that is displayed by the XStack Button may contain as many pages as you wish. It could contain text, graphics, sound, speech, music,animation, video, or any combination of them. The only requirement is that you include a script that says "pop cd" to return to Waldo.
NOTE FOR PROGRAMMERS: When opened, the script of the stack of the XStack stack could pop the pushed value into a variable or other container, e.g.:
pop cd into the last cd field
use that data later to return to Waldo.
Please ALWAYS have the script issue the command "visual effect iris close" before returning to Waldo. This is the standard visual effect for returning to Waldo from an XStack stack.
^
*XRes - eXtra Resources*
When using graphic XRes in Waldo Apple recommends that you must set the size of the HyperCard application to 2000. See your Apple documentation on how to increase your application size
XRes: When a you click on XRes at the bottom of the HyperQueue Note screen you are asked to enter a name for the XRes. The name must be no longer than 20 characters. The name must be 1 word only. You may have any characters in a name except a comma or any of the Waldo formatting characters.
(In the List view "•" (the bullet symbol) is the first character of the second word of a HyperQueue Spot if it has an XRes.)
Then when that note is the next in the Queue and
1) You have entered the Queue by clicking on the Spot (boldfaced word)
2) When the XRes key is depressed Waldo will try to display an extra resource (display picture or play sound, etc.) in a stack named the same as the document loaded with ".res" appended to the name (name.res).
§NOTE:§The Queue must be set to that word if you want to display the XRes. If the Queue is entered from the Menu (or Command key K--same as the Apple key) then holding down the Next key will Go to the next Spot in the Queue.
XRes may also be displayed a second way. While in the Note screen you may click on the XRes~name~and display/run the XRes.
When there is a XRes associated with a Spot then the name of the XRes will be placed below the Queue information at the bottom of the button panel.
The word that has the XRes will have a "gray underline."
A Spot that has a Note will have a solid underline.
A Spot that has an XRes and A Note will have a "fuzzy underline."
See the next Page for programming information.
^
*Update all Queues to version 4 form!*
Import Information for documents created with earlier versions!
The form of HyperQueue lists has been changed in Waldo 4.
If you read a document in Waldo that has a HyperQueue list that was created in an earlier version then you may load the Queue list into Waldo version 4 but not use it fully! Included with Waldo version 4 is a WaldoTool called§UpdateQueue§which will update Queues to version 4 form.
Select the Waldo menu. Select Tools.... Load~UpdateQueue~.
Select UpdateQueue from underneath Tools. The tool will update all loaded Queues to the current format. Save the Queue to disk or document.
^
*XRes - eXtra Resources - Programming A*
§NOTE§: See XHome to create XRes stacks with no programming skills at all.
When using graphic XRes in a Waldo, Apple recommends you must set the size of the HyperCard application to 2000. See your Apple documentation on how to increase your application size.
An ARTWAY FreeWare stack called "XHome" is now included with Waldo. XHome is a tool for creating XRes stacks with graphics in windows and play sounds. XHome allows non-programmers to create XRes stacks.
The XRes stack must be at the same level as the DOCUMENT loaded.
§OpenBooks:§In OpenBooks the XRes stack must be at the same level as the OpenBook--the author may optionally put them on a CD ROM
When there is a XRes associated with a Spot then the word XRes will appear on the XRes Button. The word in the text field will have a "gray underline." The external stack looks for a handler named “resource” in the script of the external stack that the author has created. The name of the XRes will be passed as well as the note, if there is one for the Spot and will be passed as a parameter to the XRes stack. It is up to the author of the XRes stack to write the handler. The Note is passed as a parameter called "resourceHolder."
XRes: When a you click on XRes at the bottom of the HyperQueue Note screen you are asked to type a name for the XRes. The name must be no longer than 20 characters. The name must be 1 word only. You may have any characters in a name except a comma or any of the Waldo formatting characters. Any illegal characters will be replaced by periods.
You will have a second option of using a list to select an XRes. If you have an XRes stack present at the correct level of your drive then Waldo will generate a list of all ~resources~in the XStack. (Programmers note this will not present a list of all handlers but only all sound and Pict resources in the XRes stack. Waldo checks the resource fork for resources, using a filter, and compiles a list.)
§NOTE:§ It is the author’s option to utilize the notes as parameters for an XRes.
The name of the XRes is passed as "resourceName".
Put this script in the STACK SCRIPT of the XRes stack to display a picture from the clipboard:
on Resource ResourceName, ResourceHolder
if ResourceName = "Home" then Resource1 ResourceName, ResourceHolder
end Resource
on Resource1 ResourceName, ResourceHolder
picture ResourceName, clipBoard
end Resource1
Waldo looks for a handler to pass parameters to (called RESOURCE) and all other resource handlers in the XRes stack must be called...RESOURCE1 and then numbered consecutively (e.g., resource2, resource3, etc.). Do not use ANY Global variables in the XRes stack! Pass parameters! Use handlers named resource and resource1,2,3...these rules must be followed in order not to interfere with Waldo's operation or to corrupt Waldo! §NOTE:§ No parameters are passed back to Waldo.
§NOTE:§ Waldo needs to find the script of the XRes in the STACK script!
(Do not place your script in the background or card.)
If you do~not~have the XHome stack then do not attempt creating XRes without reading the complete Waldo documentation and having experience programming with HyperCard.
^
*XRes - eXtra Resources - Programming B*
Authors may program XRes graphics to respond to clicking on a graphic. The handler for a particular XRes may be written so that the graphic will act as one or more buttons. The handler could respond to a click anywhere on a graphic. Also the handler could be written so as to respond to clicks in narrowly defined areas of itself (certain areas could act as separate buttons and initiate "sub-handlers." Because of scripting I have written into Waldo the author may write handlers that will:
respond to clicking after a handler has finished and anytime the graphic is visible.
§NOTE:§ Responding to clicking in XRes graphic windows is an optional function that authors may program into XRes stacks. I have put the scripting in Waldo to provide the variable for the author to utilize. If the author wishes to simply display a graphic then 1 handler is all that is needed per window.
Anytime a graphic (other than a Clipboard image pasted into a Window) is clicked on it will send a message to the XRes stack. The message will include the name of the Window and the position X,Y (relative to the XRes window not Waldo's window) of the click. The author must write a handler that will use this information if he wants to take action based on it.
"resourceName, resourceHolder,whichPicture,theMouseLoc" is sent to the handler "Resource" in the XRes stack.
resourceName is the name of the last XRes window "created"
whichPicture is the name of the window clicked on
theMouseLoc represents the location on the graphic clicked on relative to the graphic exclusively.
Clicking on one part of a graphic may initiate an animated sequence or display other graphics organized in a "tree structure." It is up to the author to program these types of functions.
^
*XRes - eXtra Resources - Programming C*
Click messages to XRes Stack
§NOTE:§Responding to clicking in XRes graphic windows is an optional function that authors may program into XRes stacks. I have put the scripting in Waldo to provide the variable for the author to utilize. If the author wishes to simply display a graphic then 1 handler is all that is needed per window.
resourceName is the name of the last XRes window "created"
whichPicture is the name of the window clicked on
theMouseLoc represents the location on the graphic clicked on
The first handler, named "Resource", in the XRes stack should check to see if the variable "whichPicture" is empty and if it is not empty check to see what window name matches whichPicture and then branch to the appropriate handler.
By creating 2 handlers for each XRes (that display graphics):
you call up handler 1 to check to see whether the the graphic has been displayed yet or if it has been clicked on. If the graphic has not been displayed yet then the 1st handler displays the graphic and then proceeds to the second handler (passing any parameters needed) to: wait for any input, preform any functions or hide the window. If the Graphic has already been displayed and the reader has clicked on it (whichPicture is not empty) then handler 1 should check for the name of the window in whichPicture and then proceed to the appropriate handler.
To restate the above:
Handler 1 checks to see if there is already a graphic displayed for that XRes NAME. If there has not been then it displays the graphic and proceeds to the 2nd handler (if the author has included it) to take some action. If there is already a graphic displayed then it proceeds directly to the second handler (this avoids having more than one copy of the graphic with one name being displayed.) and takes further action.
More detailed information is available in WaldoTools 2.
§NOTE:§When a HyperQueue List is saved to disk the file may be opened with a word processor.
"¥" is ASCII #180 (Option Y "caps lock" up or off "lowercase y"--most fonts)
§NOTE:§When you are looking at a HyperQueue list in a word processor the Yen symbol as the 1st character of a word marks the word as the name of an XRes. In the~XRes list view in Waldo~instead of showing a Yen symbol a "•"§bullet symbol§is used to mark the name of an XRes name.
^
|
*|BUTTONS-Front Page|*
^
*Import*
This button is an icon of a Page being added.This button will IMPORT a document into Waldo. The document must have been formatted in order to be loaded properly into Waldo.
^
*Delete Pages*
This button is an icon of a Page being "torn" out. If there are any Document Pages (Pages other than the Front Page), this function will delete all Document Pages.
^
*Sound Level*
This button is an icon of a Speaker. Click here and hold down the mouse to display a PopUp Menu from which to select a sound level for all sound prompts. You may select from the full range of settings from 0 to 7. If 0 is selected, then the icon is "grayed"to show that there will be no sound prompts. Any new setting will be displayed below the icon as "Level = X", where X is the level from 0 to 7. Waldo will remember the setting from session to session. Waldo will remember the setting set in the Control Panel and reset that level upon quitting Waldo.
§NOTE:§ The sound level is set by way of an XFCN from Farallon Computing, Inc.and it is copyrighted. It is included in the MacRecorder package.
^
*Page#?*
This button is an icon of a 2 ended arrow split in the middle. Clicking on it will display a dialogue box asking you to enter the Page number of the Page you wish to go to. Entering 0 will take you to the Front Page.
When the Shift Key is Down and you click on this button, you will go to a randomly selected Page.
^
*Return from Front Page*
This button is bent arrow icon.When you click the Front Page Button, this button will appear on the Front Page. Click on RETURN and you return to the Page you left from.
^
*Page#1*
This button is an icon of 1 arrow pointing to a vertical line.This button takes you to the first Document Page. Hold down the Shift key while clicking on this button and you will be taken to the last Page.When you are on Page 1, the button will be "grayed."
^
*Help*
This button is question mark (?). Click on it to display information about Waldo. When Help window is visible then the Help button will be hilited. There is a table of contents for the Help window. Click on a Topic will take you to that Topic. Click on a Topic Heading will scroll you back to that point in the table of contents. Click on the [Top] will take you to the top of the Help window. Clicking on any other word in the Help window will draw a box around the first occurrence of the word. After the first match, push the RETURN Button on your keyboard for other matches. This functions the same as the find function from the message box.
^
*ReScroll*
This button is an icon of the Scroll Bar Button.This button will re-scroll all Pages back up to the top.
^
*About Software Button*
(balloon shaped button)
This button will display information about ARTWAY when clicked on.
^
|
*|BUTTONS-Document Pages: Power functions|*
^
*TwinText*
This button is an icon of a split text field. When clicked on, it turns into an icon of a single field. This function will split the text field into two text fields. The top text field, or the TwinText™ field, contains the text of the current Page. It is a locked field and as such may not be edited. When you go to any other Page, the TwinText carries the text of its Page. This is convenient for referencing one page to other Pages or to reference one part of a Page to itself. If you are on a GroupPage Table of Contents when you click the TwinText button, then it will carry that text and you may click on the Page Titles to go to those Pages using the TwinText window as a GroupPages Table of Contents.
"HyperQueue is not disabled when TwinText is on".
If you hold down the Shift key while clicking on the split text field icon then the previous TwinText document Page will be Twined instead of the current Page.
Click on the single field icon to reset TwinText to a single text field.
^
*Title List*
This button is an icon of a List.
This is a standard button panel interface with a save-to-disk option. TITLE LIST allows you to save the Page number and Title of up to 300 Pages. You can Load, Save, Name and Erase Lists using the utility button (folder icon). You may Add and Delete items from the List. Selected a Title and click on the “Go” button and it will take you to that Page. You may transfer Titles to the Title List using the Find & Save function of the Find button panel. See "Other Functions."
Delete will delete the highlighted line if there is more than one line.
Select will select and remove the highlighted line, if there is more than one line, and give you the option of repositioning the line elsewhere in the list--Exit to abort.
Please use the ".tl" extension when naming these Lists (name.tl).
See Scan List for other function for Title Lists
§NOTE:§ Waldo will NOT ALLOW you to use the incorrect extension when saving, loading and naming Lists!
When you click on Scan button, if there are NOT any Titles in the Title List, then it will sound a single tone and a dialog box will display. If there are Titles in the Title List, then it will present a message telling you which Title you may go to next and how many Titles total are in the List. If you Exit the Scan, then the next time you click on the Scan button, you will be taken to the §next§ Title (Page) in the Title List. When you have navigated all Titles in the List, then the Scan will be reset to the first Title(Page) in the Title List. It is much simpler in practice than in explanation. Scan stops when a Note is next in the list and then hilites the Note line in the list.
ReSet will reset the scan to the highlighted line.
ReTitle function will attempt to ReTitle Pages for Title List. This feature was added for those who are retitling Waldo documents Page Titles and want to update Title Lists.
^
*Advanced Title List Features*
Adding Notes to Title lists. Click on a line while holding down the Shift key and a dialog will show the number of the current line and the total number of lines and will give you the option of adding a Note to the list. Click on an existing Note to edit a Note.
Structuring a Title list. Click on a line to hilite it. Use the Space Bar to indent and un-indent a line for emphasis. Use this feature to add more structure to your list.
If you have structured a list you may use the Tab key to navigate the list. Click on an indented line to hilite it. The Tab key will selected the next §indented§ line. Use the Shift key with the Tab key to select the §previous indented line§. Hilite an un-indented line and use the Tab/Shift Tab to select one un-indented line to the next.
By indenting items in a list and add Notes to Titles lists you may create a series of Tables on contents within the Title List. You may also add notes to the Title list. You may use notes to insert non-letter/number characters, such as a line of dashes or equal signs, to mark off sections of Title lists.
Another procedure would be to start with a Title of a Page. Next put a Note below the Title describing a fact or idea connected to that Page. Indent the Note. Then put other Titles below the first and indented them. The indented Titles could be other Pages which are related to the “heading” Title.
Title Lists may be saved to a file on disk. If you wish you may open the list in a word processor and add “@Title” on a line by itself to the top of the list--do not change anything else in the list! Use the edit menu to copy the list and paste it to the end of your document. The list will now load with the document.
^
*HyperQueue List Button*
The HyperQueue List (HQL) Button functions for maintaining the List of HyperQueues (HQ). You may have up to 10 HQs in a HQL. Each HQ may have up to 65 Spots in it (a Spot is a single word). Each Spot may have a Note and/or an XRes. A HQL could have up to 650 Spots and each may have a Notes and an XRes. You may ReSet from one HQ to another from the HQL. You may add new HQs to the HQL and re-name HQs. You may delete HQs from the List. The HQL may be saved to and reloaded from disk with the HyperQueue Utility Button.
HyperQueue lists may be saved to a file on disk. If you wish you may open the list in a word processor and add “@Queue” on a line by itself to the top of the list--do not change anything else in the list! Use the edit menu to copy the list and paste it to the end of your document. The list will now load with the document.
^
*HyperQueue Button*
The HyperQueue Button takes you into a Queue if one has been created or loaded. A button panel will be displayed at the bottom of the screen. There are buttons to:
Go to previous Spot, Go to next Spot, XRes, Note, List, Exit
The buttons with arrows allow you to go forward and backward through the Queue.
The line below the buttons shows the current Spot set. The XRes button and the Note button work with the~current~Spot.
The XRes button is name “XRes”...if the Spot has an XRes, otherwise it will have no name. Use the XRes button to display the XRes. More about XRes later.
The NEXT Arrow buttons “take” you to the Spot named in the line below the buttons.
The PREVIOUS Arrow buttons “take” you to that Spot before the current Spot.
If you want to hilite the current Spot then use the “previous” button.
Note button will display the Note window for the current Spot. You may add a Note to each Spot in a Queue. A Note may contain up to 400 characters.
List will display the List View of HyperQueues and the List buttons.
See HyperQueue List View for more information.
Exit will leave the Queue.
^
*HyperQueue List View*
The buttons in the List View button panel are:
Go, Select/Insert, Delete, Note, ReSet, Exit.
^
*Current Page Button*
Hold down the mouse button on this button to display a popup menu. The number at the bottom of the menu is the number of Marked Pages. The menu lists several functions.
Info: Select to display information about the current document.
Show All: Shows in sequence, starting with the next Marked Page, all Pages that are Marked. Click to stop.
Go To: Presents a dialog and prompts reader to enter a number. The number represents the number of a Marked Page not the Page number. For example if you enter 2 you will go to the second Page Marked not Page number 2. (Unless Page 2 was the second marked Page.)
Previous: Go to the Previous Page that is Marked.
Next: Go to the Next Marked Page.
UnMark All: UnMark all Marked Pages.
UnMark: UnMark the current Page.
Title List: Mark all Pages that are listed in the Title list.
Mark: Mark/UnMark the current Page.
---- §NOTE:§ This IS the HyperCard mark function! ----
Check in your HyperCard handbook for more on marked cards (mark, unmark, marked commands) and report function (Print Report is in the File menu). Also see "Print Report".in Menus and Current Page Button.
§OpenBooks:§ Authors may disable this function in OpenBooks.
^
|
*|BUTTONS-Document Pages: Basic Functions|*
^
*Page Graphics Button*
§OpenBook:§This button will appear only in OpenBooks and then only of the Author includes it.
This button is an icon of a video monitor. Click on it to turn Page Graphics on and off. When Page graphics are on then the screen is white. The screen is black when Page Graphics are off.
^
*LockText Button*
Click on the LockText Button to lock and unlock the text field of a Document Page to copy text. When unlocked then the icon changes to an open lock. When the text field is locked the icon is a closed lock.
NOTE: Any changes to text are not permanent.
§OpenBooks:§The author may choose to not include this button and consequently the reader will not be able to copy text or use the Print Report function from the File menu.
^
*Find*
This button is an icon of an Magnifying Glass and 2 Pages. Click here to display the Find dialog
This dialog allow you to Find a match for a word(s).
It will ask you “How to find...” and how many finds “...to a Page.”
Enter the word(s) into the find field that you wish to find.
“How to find...”
Whole: Finds exact matches only.
Start: Finds matches at beginning of words
Inside: Finds matches inside of a word(s).
Case Sensitive: Limits matches to those that match the case.
§NOTE§: Using more than one word will only find those Pages that have both words.
“...to a Page”
One: Finds only the FIRST occurrence of the word(s) on a Page.
Every: Finds EVERY occurrence of the word(s) on a Page.
When One is selected then the button “Find & Save” appears. This function gives you the option of saving the page number/Title of every matching Page to the Title List. You may do this automatically by choosing the Auto option or it will save each find as it prompts you with the Found dialog. If there are any existing Titles in the Title List you will be presented a dialog asking if you want the saved Titles to be saved after the existing Titles or if you want to overwrite the existing Titles. You may save up to 300 Titles. You will be presented a dialog asking if you wish to continue if the number will exceed 300.
The last word(s) entered in the find field is saved until a new document is loaded or until you leave the field blank
.
Find’s many options allow you to structure your search to suit your needs.
§NOTE:§ The List and the Find & Save option is available ONLY if "Power Functions" IS selected in the Waldo menu.
After using Find, the icon will change to:
"a Return Arrow crossed out and a Return Arrow."
Clicking on this icon will return you to the Page from which you started your search. If you hold down the Shift key and click on this icon, it will reset the button without returning you.
^
*Find List*
This button appears in the Find dialog and is a standard button panel function.
Select selects a word or phrase to be used for the Find function.
Delete will remove an Item from the Find List. The list may contain up to 50 items.
Sort Button sorts the list alphabetically.
Using the List utilities (the Folder Button) you may Name, Erase, Save and Load these Lists. Please use the convention of a ".fl" extension when naming these Lists (name.fl).
§NOTE:§ Waldo will NOT ALLOW you to use the incorrect extension when saving, loading and naming Lists!
^
*XStack List Button*
This button is an icon of a HyperCard Stack representing an XStack stack. Click and you will be shown a List of all Pages that have XStacks. Release the mouse button while a line is selected and you will be taken to the Page selected. If there are no XStack Buttons, then the list will be empty.
^
*Front Page*
This button is an Icon of double arrows and a vertical line.
This button will take you to the Front Page.
§NOTE:§ There is an Front Page command (Command F) on the Go menu.
^
*Page#1*
This button is an icon of 1 arrow point to a vertical line. This button takes you to the first document Page. This button is "grayed out" on Page one. Hold down the Shift key while clicking on it and you will be taken to the last Page of the current document, even if the Button is grayed out.
^
*Page# ?*
This button is an icon of a 2 headed arrow split in the middle Clicking on it will display a dialogue box asking you to enter the number of a Page to go to. Entering 0 will take you to the Front Page.
When the Shift key is down and you click on this button,you go to a randomly selected Page.
^
*< Group*
This button is an icon of a Page with a Table of Contents List. This button will take you to the previous GroupPages Table Page, if there are any. Holding down the Shift key while clicking on it will take you to the last Page of the previous GroupPages.
§NOTE:§ The GroupPage Buttons will not appear if there are no GroupPages in the currently loaded document.
^
*Group >*
This button is an icon of a Page with a Table of Contents List. This button will take you to the next GroupPages Table Page, if there are any. Holding down the Shift key while clicking on it will take you to the last Page of the next GroupPages.
§NOTE:§ The GroupPages Buttons will not appear if there are no GroupPages in the currently loaded document.
^
*<--- Buttons --->*
Page Turner Buttons
<- Button
This takes you to the previous Document Page.
If you are on Page 1, then you will go to the last Page.
-> Button
This takes you to the next Document Page.
If you are on the last Page, then you will go to the first Page.
§NOTE:§ The up & down arrow keys on the Macintosh keyboard will scroll most windows and lists up and down.
^
*Scroll-Up Arrow and Scroll-Down Arrow *
This button is an icon of the Scroll Up Arrow/Scroll Down Arrow from a Scroll Bar. It is below the Scroll Down Arrow on every document Page. Clicking on the Scroll Up Arrow will scroll the Page up one line at a time or the Scroll Down Arrow will scroll down one page at a time. Holding the mouse button down on it will scroll the Page up to the top/bottom rapidly. Holding down the Shift key while clicking on it will scroll the Page to the top/bottom in one motion.
§NOTE:§ The up & down arrow keys on the Macintosh keyboard will scroll document, table of contents and Help windows up and down.
^
*Title Page/Button Names*
This is at the bottom of all pages. Depending on whether you have selected the Show Button Names from the Waldo menu, it displays the Title of the Current Page (all pages except the Front Page) or the names of buttons. Click on the name to toggle Button /Page names.
^
|
*|Other Functions|*
^
*Save and Load Lists--Name and Erase Lists*
This button is an icon of a File Folder. This button is grouped with its related buttons. Hold down the cursor on the icon and a PopUp list will be displayed; select the function wanted and follow all prompts. You may Save and Load Find Lists, Title Lists and HyperQueue Lists to and from disk. You may also Name and Erase Lists in Waldo.
§NOTE:§ When naming Lists, use this convention:
Title List name.tl
Find List name.fl
HyperQueue List name.hl
§NOTE:§ Waldo will NOT ALLOW you to use the incorrect extension when saving, loading and naming Lists!
§NOTE:§ New to 3.4.3 the name Search Lists has been changed to Find List and the extension has been changed from ".sl" to ".fl" if you wish to load Button Lists just change their extension to ".fl"
§NOTE:§ New to 3.3 the name Button Lists has been changed to Search List and the extension has been changed from ".bl" to ".sl" if you wish to load Button Lists just change their extension to ".sl"
Using these file name extensions (.tl + .fl + .hl ) will allow for quick and error-free identification of List types and will avoid confusion when including Lists with Waldo documents.
^
*LockText Button--Copying Text from Document*
You may click on the LockText Button to lock and unlock the text field of a Document Page in order to copy text. You "unlock the text" so that you may copy the text into the clipboard. This can be used to: copy a Page into another program, copy a bit of text to re-name a Title on a Table of Contents Page, or to "Paste Into Window." Going to another Page or clicking on the button will "re-lock the text."
When unlocked then the icon changes to an open lock. When the text field is locked the icon is a closed lock.
^
*Renaming a Title*
The reader may re-name a Title in a Table of Contents Page. Hold down the Shift key while clicking on a Title will bring up a dialogue asking for a new name. If the reader enters a different Title then the new Title is in boldface. The Title in the Title Field at the bottom of document Pages holds the new Title. The title in the document Page is unchanged. To rename the Title of a GroupPage you must click on the Title in the Front Page Table of Contents only. You May click on the Title at the bottom of a document Page.
§OpenBook:§ You may not rename a Title in an OpenBook.
^
|
*|Glossary of Terms|*
^
*TwinText*
TwinText is the function in Waldo whereby the reader may split the screen in half--putting the Page’s text into both windows. The text twined will appear in the top window when the reader goes to another page.
^
*XRes*
XRes, or eXtra Resources, is a general term that includes any scripts or resources (such as graphics, QuickTime™ movies, sound) that are in an XRes Stack and are meant to be access from within Waldo via HyperQueues. You may add an XRes name to Spot in a Queue. An XRes must be put in an XRes stack to be displayed.
§OpenBook:§ When an OpenBook is created those scripts and resources will be loaded into Waldo.
^
*XRes Stack*
A XRes stack is a special stack that is placed at the same level on your hard drive as the document to be loaded into Waldo.
§OpenBook:§ XStack must be at the same level as the OpenBook.
HyperQueues may access scripts and resources (such as graphics, QuickTime™, sound) that are in an XRes stack.
§OpenBook:§When an OpenBook is created those scripts and resources will be loaded into Waldo. OpenBooks can have XRes stacks as well and they are placed at the same level as the OpenBook (locked Waldo) being read.
^
*XStack*
XStacks are special stacks that are placed at the same level as the document loaded into Waldo. They are accessed from the XStack “X” button on the lower right of a XStack button. They allow the display of eXternal stacks from within a Waldo which may or may not include interactivity and MultiMedia. To access an XStack the author or reader must use the XStack button to add X buttons on Pages that are to access XStacks. XStack Lists may be appended to documents so that X buttons are created when the document is loaded.
^
*HyperQueue*
A HyperQueue is a list of words (Spots) in the text of a Waldo. The author and reader may create HyperQueues. Spots are added at the end of a HyperQueue. A Spot may have a note and/or an XRes (resource) attached to it. A HyperQueue may have 65 Spots and there may be 10 HyperQueues (HyperQueue List) in a Waldo. HyperQueue Lists may be saved to disk, erased and loaded from disk. HyperQueue Lists, as with any Waldo lists, may be “traded” with other readers.
^
*Spot*
A Spot is any word that has been entered at the end of a HyperQueue. It will be in boldface. If it is underlined then it has a note. If it has a gray underline then it has an XRes. If it has a fuzzy underline then it has both a note and an XRes.
^
*GroupPages*
GroupPages are similar to Chapters in that they tie together a group of contiguous Pages. GroupPages differ from Chapters in that “orphan Pages,” or Pages outside of and between Chapters, are allowed.
Groups or GroupPages are a series of consecutive Pages that have been tied together when the author formats text for loading into Waldo. GroupPages have their own Title. The Title for GroupPages appears in the Table of Contents on the Front Page. Clicking on the title of a GroupPage will take you to the Table of Contents of that Group. Groups operate like chapters except that single or orphan pages are allowed. See GroupPages for information on formatting GroupPages.
^
*Page*
A Page is a block of text that has been created by the author by placing formatting characters in the text before it is loaded into Waldo. A Page may be no longer than 16k (approximately 8 pages in a word processor). Pages may be automatically given Titles or the author may format a line of text as a Title for each Page.
^
*Sending and Receiving Waldos*
When preparing Waldo documents, be sure to put all files associated with that document into a folder. Give the folder the same name as the document together with a "-F" extension -- "name-F", without the quotes. This way all associated files (help stacks, XStack stacks, notes) will be at the same level for "loading" and will not get lost on your disk. This is important! Also be sure to use an archive program like Compact Pro or Stuffit to archive and compress all files that will be transmitted over a modem or network! Stuffit is available as shareware on most bulletin boards or as a commercial program from Aladdin Systems, Inc. Compact Pro is shareware and is available from most bulletin boards.
Compact Pro: Cyclos: 109 Davis Avenue, Brookline, MA 02146
Aladdin Systems: 408-685-9175.
^
*Trouble Shooting for Authors*
If, after writing your Waldo document, you load it into Waldo and it does not load the way you expected it to, then perform a simple analysis on the document. Start with the first page, using the right arrow key at the bottom of the Page and go slowly from page to page. Repeat, using the Table of Contents and any GroupPages Tables of Contents to display each Page, starting with Page one and working forward to the last Page. Any mistakes in formatting will be found--load the document into a word processor and correct any formatting errors, save the document to disk and reload it into Waldo. Be sure not to include "quotes" in titles!
§NOTE:§ Waldo will not make errors in loading a document, so please check the text carefully for formatting errors. ALSO leading spaces at the beginning of lines that contain formatting characters will confuse Waldo. It is best to compose text on a word processor that will show "space" characters and "return" characters!
§NOTE:§ ARTWAY has programs called WaldoTools™. Checker™ is for checking documents for proper formatting--it will mark any formatting errors for quick correction of Waldo documents. ARTWAY also has a Tool for writing in Waldo to create documents which saves Waldo formatted documents to disk. Both are available from ARTWAY. Checker is available online.
^
|
*|Menus: File- Edit- Go- Waldo- Fonts- Windows|*
^
*File Menu: The Print Report*
The Print Report option in the File menu in Waldo has a
Waldo Report template set up. Check the Marked Cards option for use in conjunction with Marked Pages to print only those Pages you have marked.There are other functions you may perform on Marked Pages from the message box--see your HyperCard handbook for more uses and information on printing reports. See Marked Pages.
§OpenBook:§ Authors may disable this function OpenBooks.
^
*File menu--Compact Stack menu item*
This menu item appears in the File menu. Use this menu item to check to see if you need to compact the stack. (See your HyperCard documentation for further information on compacting stacks.) A dialog will be displayed if there is any freespace in your stack that needs to be removed. It will show the size of the Waldo stack you are reading, the size of the "freespace" in the stack and the amount of space on your disk and the amount to remove. Holding down the shift key will compact the stack without the dialog.
Command key (Apple key) and “S” will bring up the compact dialog.
If when you move from Page to Page and the freespace is about to exceed the amount of space on your disk needed to compact your stack then a dialogue box will appear with that warning and give you the option to compact the stack.
^
*Edit Menu: Paste Into Window*
With this function you may paste any copied text or graphics into a resizable window. Text exceeding Waldo's window size will be lost in the "Paste Into Window" operation and text in windows will not wrap as the text is displayed as a "graphic". When a window is created then a new menu "Windows" will appear in the menubar, as long as there are windows--see "Windows Menu" for more information. If you experience problems with this function be sure you have increased the size of the HyperCard program to 2000--see your Macintosh manual for instructions on increasing the size of applications.
^
*Help from the Go Menu/Command&?/Shift&Command&?*
§NOTE:§Waldo requires that you use HyperCard version 2.0 or higher.A hard disk is required for Waldo.
§NOTE:§HyperCard Help is available from all Pages in Waldo! If the HyperCard stack called WALDOHELP is at the same level as the current copy of Waldo, then "holding down" Shift and Command keys (Apple key) while holding down the key with the question mark (?) will display an interactive HyperCard help stack for Waldo. Also hold down the Shift key and choose help from the Go menu.
§NOTE:§For WaldoHelp--hold all 3 keys down till WALDOHELP appears.You may also access WaldoHelp by selecting Help from the "Go" menu while holding down the Shift key. WaldoHelp displays definitions of all buttons.
If no document is loaded into Waldo and the Command key is held down and then the "?" key is pushed, the standard HyperCard Help stack is displayed. If there is a document loaded, then the Command (Apple) and "?" keys will bring up a HyperCard stack named (the name of the DOCUMENT loaded)+Help--if created by the author.
e.g., NEWSHELP (not NEWS HELP)
(Authors may include help stacks with any Waldo document. Help stacks can contain any information such as a glossary of terms or index.)
^
*Front Page from the Go Menu*
Select Front Page from the Go menu or enter Command F (formerly Command P) to go to the Front page. (the command key is the same as the Apple key)
^
*Show Button Names*
When selected, a checkmark appears to the left of the menu item and the bottom of each Page displays the name of the bottom row of Buttons. When not selected, the bottom of every Document Page displays the Title of the current Page.
^
*Fonts menu*
When a font is selected, a checkmark appears to the left of the menu item.
§NOTE:§Text Size and Fonts may be changed in all displays except: XStack List, and Find List and the Help window.
^
*Power Functions*
When selected, a checkmark appears to the left of the menu item. When NOT selected, all Power functions are hidden from view, including the HyperQueue item in the Waldo menu. This is the basic mode. Basic mode is recommended as you are first learning to use Waldo. Select Basic mode and concentrate on learning basic navigation functions. After you feel comfortable with Waldo then select the Power functions and proceed to learn these more powerful features.
^
*HyperQueue*
When on Front Page, this menu item is grayed out and is not available.When selected, the message box will appear on the screen (Command K will also select this function) and gives you several options. The HyperQueue Button will also select this function.
(Command key is the same as Apple key)
§NOTE:§ If there are no Spots in the Queue then Waldo will just sound a tone, the message box will not be displayed and a dialog will appear.
Putting a word into the HyperQueue will set the word in BOLDFACE.
Putting a Note with a Spot will also UNDERLINE the word.
Putting a XRes with a Note will put GRAY UNDERLINE under the word.
Putting a Note & an XRes with a Spot will FUZZY UNDERLINE the word.
Holding down the Shift key and click on a word and it will spot that particular word with boldface. You may set up to 65 spots in a Queue.
(Queue, a common British term meaning to line up, is pronounced "Q.")
§NOTE:§The HyperQueue spots you save to a Queue are NOT "relative" to the SIZE or FONT used at the time you save spots. So,.if you reuse a saved Queue and the Size or Font of the text is different than when you set them, then they will appear in queue and IN place. Also, if you were to change SIZE or FONT of text while constructing a Queue, then it will NOT affect the function at all.
HyperQueue will ATTEMPT to warn you of mismatched Queues but will not always be able to, so exercise care in naming Queues, when they will be saved and reused. When a Queue is being loaded a tone will sound for each Spot loaded that does not match.
So the rule of thumb with Queues is the SIZE and FONT of text do NOT affect constructing and viewing a Queue. Editing a document in a word processor after you create a Queue and reloading the document will change the spots' positions on the page and then Queues will not line up!. Queues may be saved to disk with the HyperQueue utility. The utility also erases, loads and names the Queue Lists.
Either selecting HyperQueue from the Waldo menu or entering, Command K (Apple K), from the keyboard, clicking on the HyperQueue Button or just clicking on a word that is boldfaced will display the HyperQueue. If any spots have been saved to the Queue, then you may click the Next button to go to the next spot. Subsequent Next button clicks will display each spot in the Queue in the order it was entered. (New spots are entered AFTER the LAST spot in the Queue.) The Previous Button will take you backwards.
When in HyperQueue the information display at the bottom of the button panel displays information about the Queue and the name of the XRes and the page you are on.
§When entered the Queue from the Menu or Keyboard:§
The Queue is reset to that Spot (Word) you clicked on.
Notes:
On the Note screen you have the options:
Save Count Window Hide List Exit.
XRes
Notes may be up to 400 characters in length.
Window will transfer the text of a note into a floating window which may be viewed on any Page. This window will disappear when you quit Waldo and is not permanent but will display as long as you are in Waldo or until you close the window.
Save allows you to save Spots and Notes to a text file on your disk for the Queue you are in.
Count will present a quick count of the number of words in the current Note.
Window will take text from the Note and automatically create a floating window of the text.
Hide: Click on Hide and§hold down the mouse§and the note window will be hidden--it will reappear when you release the mouse button.
List Button: See below...
Exit will hide the Note window.
List Button will display the List view of the Queue
In the List view...
Delete Button will delete the selected line.
Note Button will display the Note screen for the line selected.
Reset will reset the Queue to the line highlighted selected.
Select chooses the selected line for either moving up/down within the Queue. Insert Button will place the line before the selected line. Exit aborts the selection.
Exit will exit to the HyperQueue button panel.
^
*HyperQueue and XRes*
Clicking on the XRes button on the bottom of the note screen will prompt you to type a name for an XRes or select a name from a list. If you have an XRes stack at the same level of the document...
§OpenBook:§For OpenBooks it must be at the same level as the OpenBook being read
...then a list will be generated of all resources in the XRes stack. If there already is already an XRes then you will be prompted to erase the name. Setting a name for an XRes does not automatically create an XRes. The reader or author must create either a "resource" and place it into the XRes stack with a utility like ResEdit from Apple or just use XHome from ARTWAY to create graphics and record sounds and compile a complete XRes stack without any programming. Assigning a name to an XRes makes it available as a "label" to the script in the XRes stack. It creates a "pipeline" to the script of the XRes and identifies what action to take based on the XRes name. The scripting built into Waldo takes care of most of the "overhead" for the author to attach HyperMedia functions to individual words in the document. HyperQueue names must be one word. HyperQueue names may be 20 characters long and have any character except the comma and of course and of the Waldo formatting characters. Any illegal characters are replaced with periods.
^
*HyperQueue Important Information*
The form of HyperQueue lists has been changed in Waldo 4.
If you read a document in Waldo that has a HyperQueue list that was created in an earlier version then you may load the Queue list into Waldo version 4 but not use it fully! Included with Waldo version 4 is a WaldoTool called§UpdateQueue§which will update Queues to version 4 form.
Probably More Information Than You Need
Putting a word into the HyperQueue will set the word in BOLDFACE.
Putting a Note with a Spot will also UNDERLINE the word.
Putting a XRes with a Spot will put GRAY UNDERLINE under the word.
Putting a XRes and a Note will put FUZZY UNDERLINE under the word.
Entering the Queue
The Queue may be entered from the Waldo menu (or Command K--Apple K) or by clicking on the word Spotted (Boldface). These two methods have different effects on the Queue.
There are two components to a Queue: the next Spot to select and the current Spot set.
When the Queue is entered from the~menu~then the Spot is not reset or changed in any way--the next Spot in the Queue is the next Spot in the Queue.
When a Spot is~clicked on~then the Queue is set to that word and when Go is selected then the NEXT Spot in the Queue will be displayed.
(§NOTE:§ If at this point you click to Exit then all is returned to its previous state before you clicked on the Spot.)
if there is an XRes for that Spot then the XRes button will read “XRes.” Clicking on it will display that XRes
^
*Wide Page/Narrow Page: menu item in Waldo Menu*
Waldo is distributed in the narrow format. Select Wide Page from the Waldo menu and the width of Waldo will expand to fill the width of a 640 X 400 (PowerBook) screen and will display fine on all larger screens. Choose Narrow Page when displaying on all Macintoshs with a 9 inch screen such as a SE or a Classic or a Plus.
^
*Tools... menu item in Waldo Menu*
Selecting this option will present a standard "get file" dialogue for selecting a HyperCard Tools stack. This function will only accept special "Tool stacks" from ARTWAY.The name of the stack will be placed in the Tools list underneath the "Tools..." menu item. Selecting a Tool name from the menu will access the functions programmed into the utility stack.
Hold down the Shift key while selecting a Tool name from the menu will delete the Tool from the list and Waldo.
When Tools or Waldos are moved after Tools have been added to the Tools list then when the Tool name is selected a get file dialog box will appear and you will be asked to find that Tool stack. To eliminate the dialog box delete the Tools and reload them into the menu or move the Tool or Waldo stacks back to their original level on your hard drive.
^
*Windows Menu*
When a window is displayed either because it has been created through the "Paste Into Windows" function or displayed via the XRes function of HyperQueue or another stack is open at the same time as Waldo then the Windows menu will appear like this:
√ Show Window
Close Window
------------
Clipboard 1
Clipboard 2
A check mark will appear to the left of "Show Window" when first displayed. The reader may select "Close Window." When Show Window is selected then when you select a window it will be displayed if it is hidden behind Waldo's display. When "Close Window" is checked then selecting the name of a window will close that window. As windows' names are added to the menu they are listed in alphabetical order. When all windows have been closed then the "Windows" menu will be hidden.
§NOTE:§ If you have a stack open that has the exact name as the Waldo stack you are reading, then its name will not appear in the Windows menu.
The "Close Window" option does not close the windows of stacks.
Select Show Window with the Shift key held down and all windows hidden from view will be shown.
Select "Close Window" with the Shift key held down and all windows will be closed.
§NOTE:§Palette resources and windows without names will cause the windows menu to appear but their names will not be listed in the menu.
^
|
*|Final Words About Waldo-ShareWare and Software|*
^
*Copyrights and Copying Software*
An individual, who has registered an ARTWAY ShareWare or commercial program, may make as many copies of that program as he wants for his own, single person, use.
All programs marked as FreeWare are Copyrighted programs but may be distributed free of charge by individuals and Sysops and companies who distribute FreeWare and ShareWare programs. No specific charges may be levied for individual programs. ShareWare programs are also Copyrighted software and may be distributed free of charge by individuals and Sysops and companies who distribute FreeWare and ShareWare programs.
No specific charges may be levied for individual programs. None of the files may be modified in any way, and no extra files may be added without written permission from the author. No ARTWAY commercial programs may be distributed.
Waldo may be distributed on disk, or electronically in an archive format "together" with document files, by registered authors or publishers without any additional fees. Distribution of Waldo under this agreement means that you are distributing "Waldo" as ShareWare to your readers "with" your document and must include a disclaimer encouraging registration of their copy of Waldo. ShareWare distribution prohibits distributing your document “inside” of Waldo. (See OpenBook)
A one time license at the current rate of $20 ( $30--if using an unregistered copy of Waldo) is required . The fee includes the latest version of WALDO and one copy of all ShareWare and FreeWare Waldo programs. This fee does not cover the registration for ShareWare programs other than Waldo and does not cover the registration fee for more than a single person copy of Waldo. Other persons in the same company or organization must register their copy of Waldo as a single copy. The distribution fee is only paid once per organization location. This fee does allow you to ship your document "loaded into" Waldo. Readers of OpenBooks purchase said books from authors and publishers as commercial books and as such the ShareWare terms do not apply to “locked Waldos” or “OpenBooks.”
Publishers and authors wishing to distribute Waldo with their document "locked" into Waldo must pay a one time fee of $20.00 ($30.00 if you have not registered Waldo). This requires a special password for Waldo. The "locked" Waldo is read only and does not load and delete documents after the publisher has "locked" their document into Waldo. This version is not ShareWare and can§optionally§be customized for publishers and authors for additional fees.
The OpenBook Licensing includes a voice telephone number for technical support as well as access to the ARTWAY BBS. The fee for distributing the "locked" Waldo-OpenBooks entitles the registered party to a total of 1 hour of free telephone support. Telephone support over and above the allotted time is charged on a per hour basis billed by the minute. The fee for distributing locked Waldos or "OpenBook Waldos" only covers the version of Waldo current at the time the fee is paid. Small upgrade fees will be charged if the publisher wishes to distribute later, OpenBook, versions.
^
*Authors/Publishers*
Those who are publishing Waldo books, magazines or documents need NOT obtain any special permission, but they must register THEIR copy of Waldo as soon as they publish with Waldo or as soon as they distribute in Waldo format. The Publisher/author may not distribute their document inside of Waldo--to do this the Waldo must be locked a special one time fee paid. The publisher/author is NOT responsible for readers registering their copies of Waldo. However, you are required to encourage readers to register their copies.
Authors who want to distribute text "locked" into WALDO itself must obtain a license from ARTWAY. There is a $20.00 ($30.00 for unregistered users of Waldo) one time fee for AUTHORS to distribute the locked WALDO program. The only way that documents may be distributed by publishers/authors ~in~ Waldo is by obtaining a license for OpenBook and then distributing their document in OpenBook (locked Waldo).
Publishers and authors are encouraged to send to ARTWAY notice of and copies of Waldo publications for inclusion in an international register--please include reader statistics.
Unauthorized distribution of ARTWAY programs with commercial software is prohibited unless special licenses are obtained from the author for that purpose.
^
*Other Waldos/ARTWAY Services*
ARTWAY has programs called WaldoTools™. There is an ARTWAY Tool for writing and editing Waldo documents--it automatically performs all formatting and has advanced features. It is called Soto (SM). Soto reads a variety of other forms of text including TidBits(Setext), DOS Dart, NewsBytes and MacWeek files as well as unformatted text. Custom Read-Only versions of Waldo for distribution of preloaded text can be provided for specific works. Please contact ARTWAY for details.
XHome is specialized tools for creating and working with XRes stacks.
ARTWAY provides HyperCard consulting, design, programming and instruction.
ARTWAY can create custom versions of Waldo and Waldo utilities.
ARTWAY also provides complete Second Sight BBS systems fully configured and ready to go online with Waldo BBT™. BBT is a program for publishing Waldo documents online with Second Sight. Options are available.
ARTWAY programs and ARTWAY Publishing
ARTWAY services are provided at competitive prices.
June 1994, John J. Gaudreault
^
|
*More about Waldo and CopyRights*
An individual, who has registered an ARTWAY ShareWare or commercial program, may make as many copies of that program as he wants for his own, single person, use.
All programs marked as FreeWare are Copyrighted programs but may be distributed free of charge by individuals and Sysops and companies who distribute FreeWare and ShareWare programs. No specific charges may be levied for individual programs. ShareWare programs are also Copyrighted software and may be distributed free of charge by individuals and Sysops and companies who distribute FreeWare and ShareWare programs. No specific charges may be levied for individual programs. None of the files may be modified in any way, and no extra files may be added without written permission from the author. No ARTWAY commercial programs may be distributed.
Waldo may be distributed on disk, or electronically, bundled together with but separate from document files, by authors or publishers who have registered for the one-time-only registration fee of $10.
§NOTE:§ The sound level in Waldo is set by way of an XFCN copyrighted by Farallon Computing, Inc.
Included in Waldo are:
CopyRes & KillRes (2 XCMDs) and
FullResList (1 XFCN) copyrighted by F. Rinaldi.
^
@Queue
Notes.hl
*Tips
gray,c 1502 t 1505,24,¥Quarter¬
solid,c 1555 t 1559,24,This is a note.,
fuzzy,c 1621 t 1625,24,¥Press¬This is a note.¬
clicking,c 90 t 97,27,¥Walk¬An XRes could display a floating palette such as a control pannel for controling an animation or playing music from a compact disk. Note: Waldo will not display the name of a true palette in the Windows menu. Palette work alikes may be created from regular Graphics windows.¬
ReTitle,c 1745 t 1751,41,This function exists mainly for the Quick Load feature that allows loading of untitled≈ minimally formatted text. It is also useful for Documents that do not have Titled Pages. The reader uses this feature to Title only the Pages of interest to him. It could also be of use in re-Titling Pages with personally meaninful Titles. The new Title will be in the Title field at the bottom of the Page.
text,c 108 t 111,49,You may click on the "LockText Button ( "lock" icon) and "Un-lock" the text. Select and copy the text. Select "Paste Into Window" from the Edit menu. A window with the copied text will be created. Note that the text will not wrap because it is a graphic. The winodw may be resized. The window will be named "Clipboard 1." Ohter windows will be numbered consecutively (Clipboard 1≈ Clipboard 2...).
Window,c 372 t 377,63,The windows created with "Paste Into Windows" will be lost when you quit the Waldo. Pictures and text in windows cannot be edited.
first,c 206 t 210,75,Since Pages are numbered by Waldo≈ as Pages are read into a Waldo≈ if there are irregularities in formatting they will usually show up when you go to the last Page in a Waldo. Check the last page first. And if you still suspect a problem then I would follow the suggested proceedure.
freespace,c 272 t 280,78,Most things that change something in HyperCard (adding or deleting something) will increase the freespace in a stack and unless monitored the stack's size will keep increasing until you have no more space! Waldo now monitors the freespace for you and alerts you to its status--always giving you the option to compact the stack or not.¬
window,c 112 t 117,79,If you want to reference more than 2 selections of text at a time first click on the Lock Text Button then on the desired text and copy the passage you want to see. Then select "Paste Into Window" from the Edit menu and create as many text windows as needed. They may be resized and repositioned as needed. Experiment with the zoom box and respositioning resizable windows.
XRes,c 39 t 42,86,XRes may be more than just a picture or a sound. You may utilize dialogs≈ the message box≈ "paint text" in windows≈ floating palettes≈ animation and more≈ displayed right over the document field. The graphics of XRes unlike card level graphics are displayed in windows that may be viewed when on a different Page . On screens larger that 9 inch the windows can be placed around Waldo's window.
XHome,c 656 t 660,86,XHome will create floating windows of graphics and sounds. XHome can then create an XRes stack and do all of the associated programming for you. Currently XHome≈ version 1.0.5≈ does not create animation or have the ability to handle quicktime movies. Those of you with the appropriate skills may add these functions to the finished XRes stack.
BOLDFACE,c 473 t 480,87,
UNDERLINE,c 520 t 528,87,When there is a note then the word will be underlined.
GRAY,c 576 t 579,87,¥Key¬
FUZZY,c 642 t 646,87,¥Key2¬This is a fuzzy underline. A note and an XRes.¬¬
Narrow,c 11 t 16,88,If you have a screen larger than 9 inches (SE≈ Classic and Plus have 9 inch screens) then you may move most windows "off to the side." That way they will be visible and may be brought to the front by clicking on them. Windows are in the same space as Waldo's window will be hidden behind Waldo when reader clicks in Waldo window--redisplayed via the Windows menu.
